Direct Integration API

(0 reviews)

Party Person

Sample Request

{
    "Package": {
        "Content": {
            "Application": {
                "PersonApplicant": [
                    {
                        "@HasPreviousName": "No",
                        "@Gender": "Male",
                        "@DateOfBirth": "1957-09-12",
                        "@ResidencyStatus": "Non Resident",
                        "@Citizenship": "NZ",
                        "@MaritalStatus": "Single",
                        "PrincipalForeignResidence": "NZ",
                        "PersonName": {
                            "@NameTitle": "Mr",
                            "@FirstName": "Ian",
                            "@Surname": "Abbott"
                        },
                        "Contact": {
                            "@PreferredContact": "Email",
                            "EmailAddress": {
                                "@Email": "email@email.com",
                                "@UniqueID": "e1e4f56db027"
                            },
                            "CurrentAddress": {
                                "@HousingStatus": "Own Home",
                                "@StartDate": "2021-02-10",
                                "@x_MailingAddress": "d7c56ad47d43",
                                "@x_ResidentialAddress": "d7c56ad47d43"
                            },
                            "PostSettlementAddress": {
                                "@HousingStatus": "Own Home",
                                "@x_MailingAddress": "d7c56ad47d43",
                                "@x_ResidentialAddress": "d7c56ad47d43"
                            }
                        }
                    }
                ]
            }
        }
    }
}

Detailed description of each field:

Field Name	Description	Type	Path	Required	Enumerations	Note
PersonApplicant	Contains applicant details where the applicant is a person, being either a borrower or a guarantor, and may be acting for a Trust	object	ackage.Content.Application.PersonApplicant
PersonName	The name of the person applicant	object	Package.Content.Application.PersonApplicant.PersonName
@NameTitle	The name title this person uses when they are formally addressed	string	Package.Content.Application.PersonApplicant.PersonName.NameTitle	Yes
@FirstName	A person's first name	string	Package.Content.Application.PersonApplicant.PersonName.FirstName	Yes
@MiddleNames	A person's other name. Also referred to as their 'middle name'. For example - where someone's name is Frederick Joseph Gilbert - 'Joseph' would be considered their other name	string	Package.Content.Application.PersonApplicant.PersonName.MiddleNames
@Surname	A person's surname	string	Package.Content.Application.PersonApplicant.PersonName.Surname	Yes
@KnownAs	The familiar name, nickname or preferred name by which the person wishes to be known	string	Package.Content.Application.PersonApplicant.PersonName.KnownAs
@MothersMaidenName	The mother's maiden name should be captured where this is used by the lender for identification purposes	string	Package.Content.Application.PersonApplicant.MothersMaidenName
@HasPreviousName	Indicates whether the person has a previous name	string	Package.Content.Application.PersonApplicant.HasPreviousName
PreviousName	The previous name of the applicant	object	Package.Content.Application.PersonApplicant.PreviousName
@NameTitle	The name title this person uses when they are formally addressed	string	Package.Content.Application.PersonApplicant.PreviousName.NameTitle
@FirstName	A person's first name	string	Package.Content.Application.PersonApplicant.PreviousName.FirstName
@MiddleNames	A person's other name. Also referred to as their 'middle name'. For example - where someone's name is Frederick Joseph Gilbert - 'Joseph' would be considered their other name	string	Package.Content.Application.PersonApplicant.PreviousName.MiddleNames
@Surname	A person's surname	string	Package.Content.Application.PersonApplicant.PreviousName.Surname
@Gender	Indicates the gender of the applicant	string	Package.Content.Application.PersonApplicant.Gender		Male, Female, Undisclosed
@DateOfBirth	Captures the date of birth for the applicant	date	Package.Content.Application.PersonApplicant.DateOfBirth	Yes
@CountryOfBirth	The country in which this applicant was born	string	Package.Content.Application.PersonApplicant.CountryOfBirth
@ResidencyStatus	Indicates the applicant's residency status as either a permanent resident, temporary resident or non-resident	string	Package.Content.Application.PersonApplicant.ResidencyStatus	Yes
@Citizenship	The country that the person is a citizen of	string	Package.Content.Application.PersonApplicant.Citizenship
@MaritalStatus	The marital status of the applicant should be indicated	string	Package.Content.Application.PersonApplicant.MaritalStatus	Yes	Single, Married, Seperated, De Facto, Divorced, Widowed
@PrincipalForeignResidence	The country(ies) that the person is a resident of	string	Package.Content.Application.PersonApplicant.PrincipalForeignResidence	Yes		If residencyStatus is "Non Resident" or "Temporarily in New Zealand"
@JointStatementOfPosition	Flag to indicate whether the applicant will file a joint statement of financial position with their spouse	string	Package.Content.Application.PersonApplicant.JointStatementOfPosition
Contact	Container element for the applicant contact details	object	Package.Content.Application.PersonApplicant.Contact
HomePhone	Home phone captures the phone number used predominantly while this person is at home	object	Package.Content.Application.PersonApplicant.Contact.HomePhone
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.PersonApplicant.Contact.HomePhone.Number	Yes		Mandatory if preferred contact is home phone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. "61" for Australia. Maximum length is 3 digits	string	Package.Content.Application.PersonApplicant.Contact.HomePhone.CountryCode	Yes	64	Mandatory if preferred contact is home phone
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.PersonApplicant.Contact.HomePhone.NewZealandDialingCode	Yes		Mandatory if preferred contact is home phone
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.PersonApplicant.Contact.HomePhone.OverseasDialingCode	Yes		Mandatory if preferred contact is home phone
WorkPhone	Where an applicant has a work number	object	Package.Content.Application.PersonApplicant.Contact.WorkPhone
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.PersonApplicant.Contact.WorkPhone.Number	Yes		Mandatory if preferred contact is work phone
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. "61" for Australia. Maximum length is 3 digits	string	Package.Content.Application.PersonApplicant.Contact.WorkPhone.CountryCode	Yes	64	Mandatory if preferred contact is work phone
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.PersonApplicant.Contact.WorkPhone.NewZealandDialingCode	Yes	01,011,020,021,022,023,024,025,026,027,028,029,03,04,05,050,0508,06,07,070,08,080,0800,09,090,1,50	Mandatory if preferred contact is work phone
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.PersonApplicant.Contact.WorkPhone.OverseasDialingCode	Yes	01,011,020,021,022,023,024,025,026,027,028,029,03,04,05,050,0508,06,07,070,08,080,0800,09,090,1,50	Mandatory if preferred contact is work phone
Mobile	Applicant mobile number	object	Package.Content.Application.PersonApplicant.Contact.Mobile
@Number	The local-dial number. For local rate, free call, satellite or similar special non-overseas numbers where the area or dialing code is not otherwise available, the full phone number. Required, allowed once only	string	Package.Content.Application.PersonApplicant.Contact.Mobile.Number	Yes		Mandatory if preferred contact is mobile
@CountryCode	Captures the international dialing code for the country in which the fixed phone number is located, e.g. "61" for Australia. Maximum length is 3 digits	string	Package.Content.Application.PersonApplicant.Contact.Mobile.CountryCode	Yes	64	Mandatory if preferred contact is mobile
@NewZealandDialingCode	The Area Code prefix for a New Zealand telephone number	string	Package.Content.Application.PersonApplicant.Contact.Mobile.NewZealandDialingCode	Yes		Mandatory if preferred contact is mobile
@OverseasDialingCode	The Dialing Code prefix for an overseas phone number	string	Package.Content.Application.PersonApplicant.Contact.Mobile.OverseasDialingCode	Yes		Mandatory if preferred contact is mobile
@PreferredContact	The preferred method for contacting this applicant	string	Package.Content.Application.PersonApplicant.Contact.PreferredContact	Yes	Email, Home Phone, Mobile, Work Phone
EmailAddress	Email address of the applicant	object	Package.Content.Application.PersonApplicant.Contact.EmailAddress
@Email	An email address for the person	string	Package.Content.Application.PersonApplicant.Contact.EmailAddress.Email	Yes		Mandatory if preferred contact is Email
CurrentAddress	The current address details for the applicant	object	Package.Content.Application.PersonApplicant.Contact.CurrentAddress
@x_ResidentialAddress	Reference to the applicant's current residential address	string	Package.Content.Application.PersonApplicant.Contact.CurrentAddress.x_ResidentialAddress	Yes
@StartDate	The date that the applicant moved to the residential address	date	Package.Content.Application.PersonApplicant.Contact.CurrentAddress.StartDate	Yes
@HousingStatus	Indicates the housing status of this applicant e.g. Whether they are boarding, renting, own their own home, living with parents, other, etc.	string	Package.Content.Application.PersonApplicant.Contact.CurrentAddress.HousingStatus	Yes	Boarding, Other, Own Home, Own Home Mortgage, Renting, With Parents
@x_MailingAddress	Reference to the applicant's current address for mailing documents	string	Package.Content.Application.PersonApplicant.Contact.CurrentAddress.x_MailingAddress	Yes
PostSettlementAddress	The address details for the applicant following settlement	object	Package.Content.Application.PersonApplicant.Contact.PostSettlementAddress
@x_ResidentialAddress	Reference to the applicant's residential address after settlement	string	Package.Content.Application.PersonApplicant.Contact.PostSettlementAddress.x_ResidentialAddress	Yes
@HousingStatus	Indicates the housing status of this applicant e.g. Whether they are boarding, renting, own their own home, living with parents, other, etc.	string	Package.Content.Application.PersonApplicant.Contact.PostSettlementAddress.HousingStatus	Yes	Boarding, Other, Own Home, Own Home Mortgage, Renting, With Parents
@x_MailingAddress	Reference to the applicant's address for mailing documents after settlement	string	Package.Content.Application.PersonApplicant.Contact.PostSettlementAddress.x_MailingAddress	Yes
PreviousAddress	Container element for an address previous to the current address	object
@x_ResidentialAddress	Reference to the applicant's previous residential address	string	Package.Content.Application.PersonApplicant.Contact.PreviousAddress.x_ResidentialAddress	Yes		Mandatory if current residential address is less than 3 yrs
@StartDate	The date that the applicant moved to this address	date	Package.Content.Application.PersonApplicant.Contact.PreviousAddress.StartDate	Yes		Mandatory if current residential address is less than 3 yrs
@EndDate	The date that the applicant left this address	date	Package.Content.Application.PersonApplicant.Contact.PreviousAddress.EndDate	Yes		Mandatory if current residential address is less than 3 yrs
@HousingStatus	Indicates the housing status of this applicant e.g. Whether they are boarding, renting, own their own home, living with parents, other, etc.	string	Package.Content.Application.PersonApplicant.Contact.PreviousAddress.HousingStatus	Yes	Boarding, Other, Own Home, Own Home Mortgage, Renting, With Parents	Mandatory if current residential address is less than 3 yrs

Party Person

Sample Request

Detailed description of each field:

Reviews